Skip to content

Conversation

@adiati98
Copy link
Contributor

Description

This PR holds below changes:

  • Fixed a broken link and addresses a build warning
  • Applied vale off/on statements in config.rst.

Linked issue

Closes #267

Screenshots or screen recordings

@adiati98 adiati98 requested a review from a team as a code owner September 12, 2025 08:57
@adiati98 adiati98 requested review from RCheesley and favour-chibueze and removed request for a team September 12, 2025 08:57
Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one part where I think you need to shift the Vale off/on outside the PHP method/class declarations as the content isn't showing.

.. php:method:: getType()
.. vale off
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think you can use Vale within the php class/method - this text seems to be missing:

image

Probs need to use it before the method declaration?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked my changes, and it's the same with the live website. So they all actually broken.
Maybe let's just remove the vale here. Might give some errors, but it's because of the code

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is weird. I removed the vale statements completely from here, but the result is still the same as your screenshot.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not familiar with php.
But can you confirm that the whole block is php code block?

.. php:class:: Mautic\CoreBundle\Event\RouteEvent

  .. php:method:: getType()

      :returns: The :ref:`route firewall<plugins/config:Routing firewalls>` for the given route collection.
      :returntype: string

  .. php:method:: getCollection()

      :returns: Returns a RouteCollection object that can be used to manually define custom routes.
      :returntype: \\Symfony\\Component\\Routing\\RouteCollection

  .. php:method:: addRoutes(string $path)

      Load custom routes through a resource file such as yaml or XML.

      :param string $path: Path to the resource file. For example, ``@FMElfinderBundle/Resources/config/routing.yaml``.
      :returntype: void

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If so, I think I know where it's gone wrong.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed the vale off/on. I'm not sure how these RST syntax should be rendered on the site, though. I'm asking confirmation from Rahul on Slack.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "rendering problem" has been fixed in #269. 👍🏼

@adiati98
Copy link
Contributor Author

adiati98 commented Sep 19, 2025

@RCheesley I've removed all vale statements. They don't seem to yell here.
The weird code rendered as you mentioned has been fixed in #269.

This PR now only holds below changes:

  • Fixed a broken link that caused build fails.
  • Removed excess empty lines.

So I think this is good to go.

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GTG!

@RCheesley RCheesley merged commit 1513f1a into mautic:5.x Sep 30, 2025
3 checks passed
@RCheesley
Copy link
Member

Does this also need fixing in other branches @adiati98 ?

@adiati98
Copy link
Contributor Author

I think we only have one branch in developer docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS]: Fix broken links that caused build to fail

2 participants